Scripting > CxEditors > CxCasEditor Object > CxCasEditor Methods

CxCasEditor Methods

The CxCasEditor object contains the following methods:

Configure

The Configure method launches an Alarm Service Configuration dialog box, which is used to configure the CAS.

Syntax

Configure()

Example

The following example launches an Alarm Service Configuration dialog box.

Sub

CasEditor.Configure

End Sub

Back to top

Connect

The Connect method connects to a CAS.

Syntax

Connect(DomainSiteService As String)

Parameters

Parameter Required Description

DomainSiteService

Yes

The [Domain]Site.Service to which to connect.  A domain is optional. The service must be a valid CAS.

Example

The following example creates and connects the CxCasEditor object.

Sub

Dim CasEditor

Set CasEditor = CreateObject("CxEditors.CxCasEditor")

CasEditor.Connect("[5410]CYGDEMO.CAS")

End Sub

Back to top

Copy

This method is unimplemented.

Back to top

Delete

This method is unimplemented.

Back to top

Disconnect

The Disconnect method disconnects from the connected CAS service.

Syntax

Disconnect()

Example

The following example disconnects the CasEditor object.

Sub

CasEditor.Disconnect

End Sub

Back to top

Edit

The Edit method launches an Alarm Properties property sheet for the specified point.

Syntax

Edit(QueueKey As String) As Integer

Parameters

Parameter Required Description

QueueKey

Yes

The point ID for which to edit alarm properties.  This must be in the form SITE.SERVICE.POINTID.

Remarks

This method returns one of the following values:

  -1 or 0 An error occurred.
 

1

OK button was pressed.
  2 Cancel button was pressed.

Example

The following example launches a property sheet for the point with ID "CYGDEMO.SVCMON.00003627."

Sub

Dim iRet

iRet= CasEditor.Edit("CYGDEMO.SVCMON.00003627")

 

MsgBox iRet

End Sub

Back to top

New

This method is unimplemented.

Back to top

ShowHistory

The ShowHistory method launches an Alarm History dialog box for the specified point.

Syntax

ShowHistory(Tag As String)

Parameters

Parameter Required Description

Tag

Yes

The point tag for which to show alarm history.  This must be in the form SITE.SERVICE.POINTID:POINTIDLONG.

Example

The following example launches an Alarm History dialog box for the point with ID "CYGDEMO.SVCMON.00003627:XOP_TEST55."

Sub

CasEditor.ShowHistory("CYGDEMO.SVCMON.00003627:XOP_TEST55")

End Sub

Back to top

Let us know how we can improve this topic.

CygNet at weatherford.com

© 2020 Weatherford. All rights reserved.